RCS Rich Card Message
RCS card message can be sent during the conversation with the end user. As part of Rich Card message, enterprise can send Image/ Video with Title, Description, and up to 4 Suggestions including Suggestive Reply; Open a URL; Share Location; and Dial a Number.
S.No. | Attribute | Required | Data Type | Details |
---|---|---|---|---|
3.1. | card_message | Yes | Object | Specifying that the message type is Card message |
3.1.1. | title | Yes | String | The title of the card. |
3.1.2. | description | Yes | String | The description of the card. |
3.1.3. | media_message | Yes | Object | Contains information related to the media to be sent in the message. |
3.1.3.1. | url | Yes | String | The URL of the image/video. |
3.1.4. | height | Yes | String | TALL, MEDIUM, SHORT. Image specifications are in the template specifications sheet attached above. |
3.1.5. | choices | No | Array of objects | The number of choices is limited to 4. Select any combination of choices from below objects. |
3.1.5.1. | call_message | No | Object | Button for triggering the call. |
3.1.5.1.1. | phone_number | Yes | String | Phone number in E.164 with leading +. E.g. +919876543210 |
3.1.5.1.2. | title | Yes | String | Title of the button |
3.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.5.1. | location_message | No | Object | Button containing geographic location |
3.1.5.1.1. | coordinates | Yes | Object | Containing latitude and longitude of the location |
3.1.5.1.1.1. | latitude | Yes | Number | Latitude of location |
3.1.5.1.1.2. | longitude | Yes | Number | Longitude of location |
3.1.5.1.2. | title | Yes | String | Title of the button |
3.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.5.1. | url_message | No | Object | Button for opening a URL |
3.1.5.1.1. | url | Yes | String | The URL to open |
3.1.5.1.2. | title | Yes | String | Title of the button |
3.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.5.1. | text_message | No | Object | Button for quick reply from the end user |
3.1.5.1.1. | text | Yes | String | This is the button title as well as text to be sent from the end user |
3.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
{
"app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA",
"recipient": {
"identified_by": {
"channel_identities": [
{
"channel": "RCS",
"identity": "917023002081"
}
]
}
},
"message": {
"card_message": {
"title": "Sign up for our newsletter",
"description": "Our weekly newsletter with deals and extra content!",
"media_message": {
"url": "https://sample-videos.com/img/Sample-jpg-image-100kb.jpg"
},
"height": "MEDIUM",
"choices": [
{
"text_message": {
"text": "Sign up here"
},
"postback_data": "Hello"
}
]
}
}
}